/*
 * Copyright 2007-2008 Michele Mostarda ( michele.mostarda@gmail.com ).
 * All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the 'License');
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an 'AS IS' BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


package org.asemantics.anthill.chatconsole;

/**
 * This class represens a model for the {@link org.asemantics.anthill.chatconsole.ChatCommandLine} class.
 */
public interface CommandsProvider {

    /**
     * Returns the available command names.
     *
     * @return an array containing the names of the commands.
     */
    public String[] getCommandNames();

    public Command getCommand(String commandName);

    /**
     * Returns <code>true</code> if <i>commandName</i> is a defined
     * commandName name, <code>false</code> otherwise.
     *
     * @param commandName the commandName name to check.
     * @return
     */
    public boolean isCommandName(String commandName);

    /**
     * Returns the short description of the given <i>command</i>.
     *
     * @param commandName a command name.
     * @return a textual description.
     */
    public String getCommandShortDescription(String commandName);

    /**
     * Returns the long description of the given <i>commandName</i>.
     *
     * @param commandName a commandName name.
     * @return a textual description.
     */
    public String getCommandLongDescription(String commandName);

}
